oracle.AWXML
Class DimensionMemberExpression

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.DimensionMemberExpression

public class DimensionMemberExpression

extends BaseObject

A set of dimension members for a DimensionMemberSelection or a PreComputeClause. A DimensionMemberExpression can specify a Level or an expression that identifies one or more dimension members. A DimensionMemberExpression also has an expression type that specifies whether to include or exclude the specified members in the operation that uses the DimensionMemberExpression.

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

DimensionMemberExpression(BaseObject input)
Creates a DimensionMemberExpression for the specified DimensionMemberSelection or PreComputeClause.

Method Summary

java.lang.String	getExpression() Gets the expression specified by the DimensionMemberExpression.
java.lang.String	getExpressionText() Gets the expression type and either the text expression or the identifier of the Level specified by the DimensionMemberExpression.
java.lang.String	getExpressionType() Gets the expression type specified for the DimensionMemberExpression.
Level	getLevel() Gets the Level specified by the DimensionMemberExpression.
void	setExpression(java.lang.String input) Specifies an expression for the DimensionMemberExpression.
void	setExpressionType(java.lang.String input) Specifies an expression type for the DimensionMemberExpression.
void	setLevel(Level input) Specifies the Level that has the members that you want to include or exclude from the selection.
java.lang.String	WriteToXML() Gets an XML representation of the DimensionMemberExpression.

Methods inherited from class oracle.AWXML.BaseObject

Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DimensionMemberExpression

public DimensionMemberExpression(BaseObject input)

Creates a DimensionMemberExpression for the specified DimensionMemberSelection or PreComputeClause. An application should create a DimensionMemberExpression by using the createDimensionMemberExpression method of the DimensionMemberSelection or PreComputeClause.

Parameters:

input - The DimensionMemberSelection or PreComputeClause to own the new DimensionMemberExpression.

Method Detail

getExpressionType

public java.lang.String getExpressionType()

Gets the expression type specified for the DimensionMemberExpression. The expression type can be INCLUDE or EXCLUDE.

Returns:

A String that contains the expression type specified for the DimensionMemberExpression.

setExpressionType

public void setExpressionType(java.lang.String input)

Specifies an expression type for the DimensionMemberExpression. The expression type can be INCLUDE or EXCLUDE. The expression type specifies whether the DimensionMemberSelection includes or excludes the members specified by the DimensionMemberExpression in the selection of members that it represents.

Parameters:

input - A String that contains INCLUDE if you want the DimensionMemberSelection to include the specified members or EXCLUDE if you want the selection to exclude the members.

getExpression

public java.lang.String getExpression()

Gets the expression specified by the DimensionMemberExpression.

Returns:

A String that contains the expression specified by the DimensionMemberExpression.

setExpression

public void setExpression(java.lang.String input)

Specifies an expression for the DimensionMemberExpression. The expression identifies a single dimension member by value, a set of members by attribute value, or all of the dimension members.

To select or exclude all members, specify ALL.

The syntax for a dimension member selection by member value is the following.

Dimension_Name.DIMENSION:"Member_Value"

The syntax for a dimension member selection by attribute value is the following.

Dimension_Name.Attribute_Name.ATTRIBUTE="Attribute_Value"

The following are examples of both forms of specifying an expression.

 // Specifies the dimension member that has the value 13.
 myDimMemberExp.setExpression("PRODUCT_AW.DIMENSION:\"13\"");

 // Specifies the dimension members that have the PACKAGE_AW attribute
 // value Executive.
 myDimMemberExp2.setExpression("PRODUCT_AW.PACKAGE_AW.ATTRIBUTE=/"Executive/"");

If you specify dimension members with this method, then do not use the setLevel method.

Parameters:

input - A String that contains an expression that specifies one or more dimension members.

setLevel

public void setLevel(Level input)

Specifies the Level that has the members that you want to include or exclude from the selection.

If specify a Level with this method, then do not use the setExpression method.

Parameters:

input - The Level that has the members to select.

getLevel

public Level getLevel()

Gets the Level specified by the DimensionMemberExpression.

Returns:

The Level specified by the DimensionMemberExpression.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the DimensionMemberExpression.

Overrides:

WriteToXML in class BaseObject

Returns:

An XML String that represents the DimensionMemberExpression.

getExpressionText

public java.lang.String getExpressionText()

Gets the expression type and either the text expression or the identifier of the Level specified by the DimensionMemberExpression.

Returns:

A String that contains the expression type and the text expression or Level identifier.